<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>ArcticSEA: CReceiver Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">ArcticSEA
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="class_c_receiver-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">CReceiver Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Class to work with navigation receiver via serial port.  
 <a href="class_c_receiver.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for CReceiver:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_c_receiver.png" usemap="#CReceiver_map" alt=""/>
  <map id="CReceiver_map" name="CReceiver_map">
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6056c0c1f4f2ce1306e5068cafc27231"><td class="memItemLeft" align="right" valign="top">function&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_receiver.html#a6056c0c1f4f2ce1306e5068cafc27231">CReceiver</a> ()</td></tr>
<tr class="memdesc:a6056c0c1f4f2ce1306e5068cafc27231"><td class="mdescLeft">&#160;</td><td class="mdescRight">Consturctor of this class.  <a href="#a6056c0c1f4f2ce1306e5068cafc27231">More...</a><br/></td></tr>
<tr class="separator:a6056c0c1f4f2ce1306e5068cafc27231"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb26454266315d70b8cd980440131b2c"><td class="memItemLeft" align="right" valign="top">function&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_receiver.html#abb26454266315d70b8cd980440131b2c">SerialConfig</a> (in RCV, in COM, in Baud)</td></tr>
<tr class="memdesc:abb26454266315d70b8cd980440131b2c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set parameters of serial port.  <a href="#abb26454266315d70b8cd980440131b2c">More...</a><br/></td></tr>
<tr class="separator:abb26454266315d70b8cd980440131b2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d8dc5af14b27f0abc720e0bc60e5903"><td class="memItemLeft" align="right" valign="top">function&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_receiver.html#a1d8dc5af14b27f0abc720e0bc60e5903">SerialConnect</a> (in RCV)</td></tr>
<tr class="memdesc:a1d8dc5af14b27f0abc720e0bc60e5903"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to receiver by serial port.  <a href="#a1d8dc5af14b27f0abc720e0bc60e5903">More...</a><br/></td></tr>
<tr class="separator:a1d8dc5af14b27f0abc720e0bc60e5903"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05982a8b657d04cebc74f39a6737a523"><td class="memItemLeft" align="right" valign="top">function&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_receiver.html#a05982a8b657d04cebc74f39a6737a523">RecieveString</a> (in RCV)</td></tr>
<tr class="memdesc:a05982a8b657d04cebc74f39a6737a523"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read data from receiver.  <a href="#a05982a8b657d04cebc74f39a6737a523">More...</a><br/></td></tr>
<tr class="separator:a05982a8b657d04cebc74f39a6737a523"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a998ae45117346e1ab1fb5511d5fe295d"><td class="memItemLeft" align="right" valign="top">function&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_receiver.html#a998ae45117346e1ab1fb5511d5fe295d">SerialClose</a> (in RCV)</td></tr>
<tr class="memdesc:a998ae45117346e1ab1fb5511d5fe295d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close connection to receiver.  <a href="#a998ae45117346e1ab1fb5511d5fe295d">More...</a><br/></td></tr>
<tr class="separator:a998ae45117346e1ab1fb5511d5fe295d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24d9be27941e8c593a588df56f0cafe1"><td class="memItemLeft" align="right" valign="top">function&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_receiver.html#a24d9be27941e8c593a588df56f0cafe1">Reset</a> (in RCV)</td></tr>
<tr class="memdesc:a24d9be27941e8c593a588df56f0cafe1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset receiver ( NMEA string is true for GEOS-3 )  <a href="#a24d9be27941e8c593a588df56f0cafe1">More...</a><br/></td></tr>
<tr class="separator:a24d9be27941e8c593a588df56f0cafe1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18db451b4401eafbd75f549b880426b6"><td class="memItemLeft" align="right" valign="top">function&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_receiver.html#a18db451b4401eafbd75f549b880426b6">GetSolutionStatus</a> (in RCV)</td></tr>
<tr class="memdesc:a18db451b4401eafbd75f549b880426b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get solution status and store it in FixType.  <a href="#a18db451b4401eafbd75f549b880426b6">More...</a><br/></td></tr>
<tr class="separator:a18db451b4401eafbd75f549b880426b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:aa183133c9a503dedcbc649d94a01c95f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa183133c9a503dedcbc649d94a01c95f"></a>
Property&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_receiver.html#aa183133c9a503dedcbc649d94a01c95f">obj</a></td></tr>
<tr class="memdesc:aa183133c9a503dedcbc649d94a01c95f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer of serial connection. <br/></td></tr>
<tr class="separator:aa183133c9a503dedcbc649d94a01c95f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a545e0896a323d38b6eec4fc756628f0b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a545e0896a323d38b6eec4fc756628f0b"></a>
Property&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_receiver.html#a545e0896a323d38b6eec4fc756628f0b">FixType</a></td></tr>
<tr class="memdesc:a545e0896a323d38b6eec4fc756628f0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of solution (1 - No solution, 2 - 2D, 3 - 3D) <br/></td></tr>
<tr class="separator:a545e0896a323d38b6eec4fc756628f0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class to work with navigation receiver via serial port. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a6056c0c1f4f2ce1306e5068cafc27231"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">function CReceiver::CReceiver </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Consturctor of this class. </p>
<p>This is constructor of Receiver control class<br/>
 Example: Rec1 = <a class="el" href="class_c_receiver.html" title="Class to work with navigation receiver via serial port.">CReceiver</a>;</p>
<dl class="section return"><dt>Returns</dt><dd>RCV Object of this class </dd></dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a18db451b4401eafbd75f549b880426b6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">function CReceiver::GetSolutionStatus </td>
          <td>(</td>
          <td class="paramtype">in&#160;</td>
          <td class="paramname"><em>RCV</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get solution status and store it in FixType. </p>
<p>Example: Rec1.GetSolutionStatus; </p>

</div>
</div>
<a class="anchor" id="a05982a8b657d04cebc74f39a6737a523"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">function CReceiver::RecieveString </td>
          <td>(</td>
          <td class="paramtype">in&#160;</td>
          <td class="paramname"><em>RCV</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Read data from receiver. </p>
<p>Example: Rec1.RecieveString; </p>
<dl class="section return"><dt>Returns</dt><dd>Answer Data from receiver </dd></dl>

</div>
</div>
<a class="anchor" id="a24d9be27941e8c593a588df56f0cafe1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">function CReceiver::Reset </td>
          <td>(</td>
          <td class="paramtype">in&#160;</td>
          <td class="paramname"><em>RCV</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reset receiver ( NMEA string is true for GEOS-3 ) </p>
<p>Example: Rec1.Reset; </p>

</div>
</div>
<a class="anchor" id="a998ae45117346e1ab1fb5511d5fe295d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">function CReceiver::SerialClose </td>
          <td>(</td>
          <td class="paramtype">in&#160;</td>
          <td class="paramname"><em>RCV</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Close connection to receiver. </p>
<p>Example: Rec1.SerialClose; </p>
<dl class="section return"><dt>Returns</dt><dd>Status Is 0 - fail; 1 - ok. </dd></dl>

</div>
</div>
<a class="anchor" id="abb26454266315d70b8cd980440131b2c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">function CReceiver::SerialConfig </td>
          <td>(</td>
          <td class="paramtype">in&#160;</td>
          <td class="paramname"><em>RCV</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">in&#160;</td>
          <td class="paramname"><em>COM</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">in&#160;</td>
          <td class="paramname"><em>Baud</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set parameters of serial port. </p>
<p>Example: Rec1.SerialConfig('COM7', 115200); </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">COM</td><td>String port name </td></tr>
    <tr><td class="paramname">Baud</td><td>Baud rate </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a1d8dc5af14b27f0abc720e0bc60e5903"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">function CReceiver::SerialConnect </td>
          <td>(</td>
          <td class="paramtype">in&#160;</td>
          <td class="paramname"><em>RCV</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Connect to receiver by serial port. </p>
<p>Example: Rec1.SerialConnect; </p>
<dl class="section return"><dt>Returns</dt><dd>Status Is 0 - fail; 1 - ok. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_c_receiver_8m.html">CReceiver.m</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 8 2013 16:21:14 for ArcticSEA by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
